home *** CD-ROM | disk | FTP | other *** search
/ InfoMagic Internet Tools 1995 April / Internet Tools.iso / infoserv / gopher / Unix / xvgopher / v0.5beta / xvgopher.shar.01.Z / xvgopher.shar.01 / README < prev    next >
Encoding:
Text File  |  1993-03-25  |  6.0 KB  |  143 lines
  1. README
  2.  
  3. This is a beta release of xvgopher -- an XView based gopher client.
  4.  
  5. Gopher is a distributed information browsing/retrieval system used at
  6. many universities and other institutions to make information and
  7. services available in a user friendly and consistent manner.
  8.  
  9. NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE
  10. This is a beta release!  This means that I am still very actively working
  11. on xvgopher, but I got many requests to make it available ASAP.
  12. Please report any problems you find as soon as possible so that I can
  13. incorporate the fixes in the first major release.
  14. The latest release will always be available.  There are two ways of
  15. accessing it:
  16.  
  17.     anonymous ftp to gopher.sdsu.edu in /pub/xvgopher
  18.     gopher to gopher.sdsu.edu: Software Distribution/UNIX/XvGopher
  19.  
  20.  
  21. HISTORY OF XVGOPHER
  22. We started out wanting something similar to TurboGopher (a Macintosh
  23. gopher client.  Really nice!!) for MS-Windows.  There are several good
  24. pc gopher clients available, but the ones I checked out either didn't
  25. run as a MS-Windows application, weren't public domain, or required
  26. some non- public domain networking software.  (We are on an extreemly
  27. low budget...) So, we decided to write one...
  28.  
  29. Well, this would have been great, but I refused to write any MS-Windows
  30. applications on my 20 MHz 386!  So, while waiting for a better PC, I
  31. decided I might as well write a prototype using XView.
  32.  
  33. I should point out that there is a pretty nice X11 gopher client
  34. available called xgopher.  However, it boils down to a fancy window
  35. around something similar to the text based gopher client.  (This is
  36. greatly exaggerated, of course!)  We did use the gopher icon that
  37. xgopher uses.  It is pretty cute (and none of us are good artists.)
  38.  
  39. The prototype I started writing turned out to be quite usable and we
  40. started using it instead of the text based client.  It is not a
  41. prototype anymore; it is now a full gopher client.
  42.  
  43. I wrote all of xvgopher in C++ because that is the language I am most
  44. comfortable with.  I used the Sniff C++ development system to write
  45. all the code and I used Sun's DevGuide to figure out sizes of windows and
  46. locations of buttons.  I did not use DevGuide for the code generation
  47. for several reasons:  1) Not everyone has DevGuide which makes it hard
  48. to distribute the source code.  2) The C++ code generator that comes with
  49. DevGuide doesn't really do anything in an object oriented way.  It would
  50. make the code horrible!  (Actually, XView is not very easy to integrate
  51. in an object oriented program because of all the callbacks...)
  52.  
  53.  
  54. SYSTEM REQUIREMENTS
  55. xvgopher is written in C++.  This may scare some people, but not to
  56. worry.  If you do not have a C++ compiler, just get gcc 2.3.3 and
  57. libg++.  xvgopher will compile with those just fine.  So far it has
  58. been tested on various suns running SunOS 4.1.X and on an HP 750.
  59. The code does not use any C++ features not available in cfront 2.1.  So
  60. if your C++ compiler does not support templates....  neither does
  61. ours!!!  (We only just got SunPRO's C++ 3.0 compiler.  Thanks for the
  62. great 15 minute license linger time, SunPRO!!!!! :-(  Stuff like that
  63. doesn't work in a University environment!  (ANDREW!!!  GET OFF THAT
  64. SOAP BOX!!!)) xvgopher also requires that you have XView3 installed on
  65. your system.  If you have Sun's Openwin 3.0, that's fine too, although
  66. you will have to have the 'Openwin Programmers' section installed.  The
  67. only other requirement is that you have to have some network so you can
  68. talk to a gopher server.
  69.  
  70.  
  71. CONFIGURING
  72. Configuring xvgopher is pretty straight forward.  Just edit
  73. 'xvgopher.h' and change the defines above the section that says to not
  74. edit anything below it.  (Did I make you read that sentence twice??
  75. :-)) Then edit the Makefile and change the macros to your liking.
  76.  
  77.  
  78. COMPILING & LINKING
  79. Type 'make depend'
  80. Type 'make'
  81.  
  82.  
  83. INSTALLING
  84. type 'make install'
  85. It will install the xvgopher executable and the man page.
  86.  
  87.  
  88. USER CONFIGURATION
  89. The first time xvgopher is run by a user, it creates ~/.xvgopher-defaults.
  90. This file contains all the currently configurable items.  The easiest
  91. is to change those parameters using the Preferences popup, but they can
  92. also be edited by hand.  Xvgopher uses the X11 resource database
  93. routines to read the items, so the format of the file should be
  94. familiar.  When bookmarks are created, a file called ~/.xvgopher-bm
  95. will be created which contains a list of bookmarks.  The bookmarks are
  96. stored in the same way they information was sent from a gopher server
  97. to xvgopher.  If you are not familiar with the gopher protocol, don't
  98. worry about it.  If you ARE familiar with the gopher protocol, don't
  99. worry about it too much.
  100.  
  101. CREDITS
  102. (These really should be slowly scrolling by while appropriate music
  103. is playing, but you have to wait for version 427 for that feature...)
  104. Thanks to all the people who have done testing and given me feedback
  105. on the design and implementation of xvgopher.  
  106. Here are some names:
  107.  
  108. Mark Boyns (SDSU)            -- testing & UI layout & icons
  109. John Denune (SDSU)            -- testing
  110. Mike Halderman (NOSC)            -- testing
  111. Paul Lindner (UMN)            -- gopher icon
  112.  
  113.  
  114. BUGS, COMMENTS, GRIPES, MONEY, LOVE
  115. If you have any of the above directed at me, I'd like to hear about
  116. it!  I would especially welcome any bug reports (and possible fixes)
  117. and also comments.  I like getting email!
  118. Basically, if you like it, let me know why.
  119. If you dislike it, let me know why.
  120. If you had problems, let me know why.
  121. If you have not tried xvgopher but still have comments about it, let me
  122. know why.
  123. If you don't like me, let me know why.
  124. If you think this is getting silly, let me know why.
  125. If you are still reading this list of questions, you owe me beer!!!
  126.  
  127.  
  128. WHERE IS ANDREW??
  129. Well, I am reachable by email at turtle@sciences.sdsu.edu
  130.  
  131. Happy gophering to y'all!  C++'ya in gopherspace.
  132.  
  133.  
  134. --Andrew
  135. ____________________________________________________________________________
  136. Andrew "Race Turtle" Scherpbier, SysMgr
  137. College of Sciences
  138. San Diego State University
  139. EMAIL:    turtle@sciences.sdsu.edu
  140. VOICE:    (619) 594-5026
  141. FAX:    (619) 594-6381
  142. ____________________________________________________________________________
  143.